Docs: Recommend using bound function reference instead of watch=True in bind_component guide - #8479
Merged
Merged
Conversation
3 tasks
ahuang11
reviewed
Mar 6, 2026
Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>
Co-authored-by: Andrew <15331990+ahuang11@users.noreply.github.com>
philippjfr
approved these changes
Mar 9, 2026
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #6271
This PR updates the documentation in
doc/how_to/interactivity/bind_component.mdto clarify the recommended pattern for usingpn.bindwhen updating component parameters.Users coming from
param.watch()patterns may attempt to usewatch=Truewithpn.bind. However, this pattern recreates the object whenever the inputs change and is generally considered an anti-pattern.This PR adds a section explaining that a better approach is to assign the bound function directly to the relevant component parameter. For example:
This approach keeps the component reactive while avoiding unnecessary object recreation and ensures that only the relevant parameter is updated.
The documentation change clarifies the intended usage of
pn.bindand improves guidance for users working with reactive components.How Has This Been Tested?
This change only modifies documentation.
The updated section was reviewed locally to ensure:
Since this is a documentation-only change, no runtime functionality or tests were affected.
AI Disclosure
Tools: ChatGPT
Checklist